Microsoft Cognitive Language Service - Analyze Text Authoring (preview:2024-11-15)

2024/12/09 • 49 updated methods

TextAnalysisAuthoring_ListProjects (updated)
Description Lists the existing projects.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_ListProjects",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "projectKind",
              "Enum": {
                "new": [
                  [
                    "CustomSingleLabelClassification",
                    "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
                  ],
                  [
                    "CustomMultiLabelClassification",
                    "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
                  ],
                  [
                    "CustomEntityRecognition",
                    "For building an extraction model to identify your domain categories using your own data."
                  ],
                  [
                    "CustomAbstractiveSummarization",
                    "For building an abstractive summarization models which are able to summarize long documents."
                  ],
                  [
                    "CustomHealthcare",
                    "For building an text analytics for health model to identify your health domain data."
                  ],
                  [
                    "CustomTextSentiment",
                    "For building a sentiment models which are able to extract sentiment for long documents."
                  ]
                ],
                "old": [
                  [
                    "CustomSingleLabelClassification",
                    "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
                  ],
                  [
                    "CustomMultiLabelClassification",
                    "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
                  ],
                  [
                    "CustomEntityRecognition",
                    "For building an extraction model to identify your domain categories using your\nown data."
                  ],
                  [
                    "CustomAbstractiveSummarization",
                    "For building an abstractive summarization models which are able to summarize\nlong documents."
                  ],
                  [
                    "CustomHealthcare",
                    "For building an text analytics for health model to identify your health domain\ndata."
                  ],
                  [
                    "CustomTextSentiment",
                    "For building a sentiment models which are able to extract sentiment for long\ndocuments."
                  ]
                ]
              }
            },
            {
              "settings": [
                {
                  "#name": "confidenceThreshold",
                  "Description": {
                    "new": "The threshold of the class with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.",
                    "old": "The threshold of the class with the highest confidence, at which the prediction\nwill automatically be changed to \"None\". The value of the threshold should be\nbetween 0 and 1 inclusive."
                  }
                }
              ]
            },
            {
              "#name": "language",
              "Description": {
                "new": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
                "old": "The project language. This is BCP-47 representation of a language. For example,\nuse \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects
{
api-version: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
createdDateTime: string ,
lastModifiedDateTime: string ,
lastTrainedDateTime: string ,
lastDeployedDateTime: string ,
projectKind: enum ,
storageInputContainerName: string ,
settings:
{
confidenceThreshold: number ,
amlProjectPath: string ,
isLabelingLocked: boolean ,
runGptPredictions: boolean ,
gptPredictiveLookahead: integer ,
}
,
projectName: string ,
multilingual: boolean ,
description: string ,
language: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetProject (updated)
Description Gets the details of a project.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetProject",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "projectKind",
          "Enum": {
            "new": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your own data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize long documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain data."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long documents."
              ]
            ],
            "old": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your\nown data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize\nlong documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain\ndata."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long\ndocuments."
              ]
            ]
          }
        },
        {
          "settings": [
            {
              "#name": "confidenceThreshold",
              "Description": {
                "new": "The threshold of the class with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.",
                "old": "The threshold of the class with the highest confidence, at which the prediction\nwill automatically be changed to \"None\". The value of the threshold should be\nbetween 0 and 1 inclusive."
              }
            }
          ]
        },
        {
          "#name": "language",
          "Description": {
            "new": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
            "old": "The project language. This is BCP-47 representation of a language. For example,\nuse \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
          }
        }
      ]
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}
{
api-version: string ,
projectName: string ,
}

⚐ Response (200)

{
createdDateTime: string ,
lastModifiedDateTime: string ,
lastTrainedDateTime: string ,
lastDeployedDateTime: string ,
projectKind: enum ,
storageInputContainerName: string ,
settings:
{
confidenceThreshold: number ,
amlProjectPath: string ,
isLabelingLocked: boolean ,
runGptPredictions: boolean ,
gptPredictiveLookahead: integer ,
}
,
projectName: string ,
multilingual: boolean ,
description: string ,
language: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_CreateProject (updated)
Description The most basic operation that applies to a resource.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_CreateProject",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "projectKind",
          "Enum": {
            "new": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your own data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize long documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain data."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long documents."
              ]
            ],
            "old": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your\nown data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize\nlong documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain\ndata."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long\ndocuments."
              ]
            ]
          }
        },
        {
          "settings": [
            {
              "#name": "confidenceThreshold",
              "Description": {
                "new": "The threshold of the class with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.",
                "old": "The threshold of the class with the highest confidence, at which the prediction\nwill automatically be changed to \"None\". The value of the threshold should be\nbetween 0 and 1 inclusive."
              }
            }
          ]
        },
        {
          "#name": "language",
          "Description": {
            "new": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
            "old": "The project language. This is BCP-47 representation of a language. For example,\nuse \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "projectKind",
          "Enum": {
            "new": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your own data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize long documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain data."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long documents."
              ]
            ],
            "old": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your\nown data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize\nlong documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain\ndata."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long\ndocuments."
              ]
            ]
          }
        },
        {
          "settings": [
            {
              "#name": "confidenceThreshold",
              "Description": {
                "new": "The threshold of the class with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.",
                "old": "The threshold of the class with the highest confidence, at which the prediction\nwill automatically be changed to \"None\". The value of the threshold should be\nbetween 0 and 1 inclusive."
              }
            }
          ]
        },
        {
          "#name": "language",
          "Description": {
            "new": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
            "old": "The project language. This is BCP-47 representation of a language. For example,\nuse \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "projectKind",
          "Enum": {
            "new": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your own data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize long documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain data."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long documents."
              ]
            ],
            "old": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your\nown data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize\nlong documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain\ndata."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long\ndocuments."
              ]
            ]
          }
        },
        {
          "settings": [
            {
              "#name": "confidenceThreshold",
              "Description": {
                "new": "The threshold of the class with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.",
                "old": "The threshold of the class with the highest confidence, at which the prediction\nwill automatically be changed to \"None\". The value of the threshold should be\nbetween 0 and 1 inclusive."
              }
            }
          ]
        },
        {
          "#name": "language",
          "Description": {
            "new": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
            "old": "The project language. This is BCP-47 representation of a language. For example,\nuse \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
          }
        }
      ]
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /authoring/analyze-text/projects/{projectName}
{
api-version: string ,
projectName: string ,
body:
{
projectKind: enum ,
storageInputContainerName: string ,
settings:
{
confidenceThreshold: number ,
amlProjectPath: string ,
isLabelingLocked: boolean ,
runGptPredictions: boolean ,
gptPredictiveLookahead: integer ,
}
,
projectName: string ,
multilingual: boolean ,
description: string ,
language: string ,
}
,
}

⚐ Response (200)

{
createdDateTime: string ,
lastModifiedDateTime: string ,
lastTrainedDateTime: string ,
lastDeployedDateTime: string ,
projectKind: enum ,
storageInputContainerName: string ,
settings:
{
confidenceThreshold: number ,
amlProjectPath: string ,
isLabelingLocked: boolean ,
runGptPredictions: boolean ,
gptPredictiveLookahead: integer ,
}
,
projectName: string ,
multilingual: boolean ,
description: string ,
language: string ,
}

⚐ Response (201)

{
createdDateTime: string ,
lastModifiedDateTime: string ,
lastTrainedDateTime: string ,
lastDeployedDateTime: string ,
projectKind: enum ,
storageInputContainerName: string ,
settings:
{
confidenceThreshold: number ,
amlProjectPath: string ,
isLabelingLocked: boolean ,
runGptPredictions: boolean ,
gptPredictiveLookahead: integer ,
}
,
projectName: string ,
multilingual: boolean ,
description: string ,
language: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_DeleteProject (updated)
Description Deletes a project.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_DeleteProject",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}
{
api-version: string ,
projectName: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_CopyProjectAuthorization (updated)
Description Generates a copy project operation authorization to the current target Azure resource.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_CopyProjectAuthorization",
  "Description": {
    "new": "Generates a copy project operation authorization to the current target Azure resource.",
    "old": "Generates a copy project operation authorization to the current target Azure\nresource."
  },
  "$parameters": {
    "body": {
      "Description": {
        "new": "Represents the options for authorizing a project copy to the current Azure resource.",
        "old": "Represents the options for authorizing a project copy to the current Azure\nresource."
      },
      "$properties": [
        {
          "#name": "projectKind",
          "Enum": {
            "new": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your own data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize long documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain data."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long documents."
              ]
            ],
            "old": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your\nown data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize\nlong documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain\ndata."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long\ndocuments."
              ]
            ]
          }
        },
        {
          "#name": "allowOverwrite",
          "Description": {
            "new": "Whether to allow an existing project to be overwritten using the resulting copy authorization.",
            "old": "Whether to allow an existing project to be overwritten using the resulting copy\nauthorization."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Represents the options for copying an existing project to another Azure resource.",
        "old": "Represents the options for copying an existing project to another Azure\nresource."
      },
      "$properties": [
        {
          "#name": "projectKind",
          "Enum": {
            "new": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your own data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize long documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain data."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long documents."
              ]
            ],
            "old": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your\nown data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize\nlong documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain\ndata."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long\ndocuments."
              ]
            ]
          }
        }
      ]
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:authorize-copy
{
api-version: string ,
projectName: string ,
body:
{
projectKind: enum ,
storageInputContainerName: string ,
allowOverwrite: boolean ,
}
,
}

⚐ Response (200)

{
projectKind: enum ,
targetProjectName: string ,
accessToken: string ,
expiresAt: string ,
targetResourceId: string ,
targetResourceRegion: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_CopyProject (updated)
Description Copies an existing project to another Azure resource.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_CopyProject",
  "$parameters": {
    "body": {
      "Description": {
        "new": "Represents the options for copying an existing project to another Azure resource.",
        "old": "Represents the options for copying an existing project to another Azure\nresource."
      },
      "$properties": [
        {
          "#name": "projectKind",
          "Enum": {
            "new": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your own data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize long documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain data."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long documents."
              ]
            ],
            "old": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your\nown data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize\nlong documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain\ndata."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long\ndocuments."
              ]
            ]
          }
        }
      ]
    }
  },
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:copy
{
api-version: string ,
projectName: string ,
body:
{
projectKind: enum ,
targetProjectName: string ,
accessToken: string ,
expiresAt: string ,
targetResourceId: string ,
targetResourceRegion: string ,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_Export (updated)
Description Triggers a job to export a project's data.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_Export",
  "$parameters": [
    {
      "#name": "stringIndexType",
      "Description": {
        "new": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.",
        "old": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets."
      }
    },
    {
      "#name": "trainedModelLabel",
      "Description": {
        "new": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.",
        "old": "Trained model label to export. If the trainedModelLabel is null, the default\nbehavior is to export the current working copy."
      }
    }
  ],
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:export
{
api-version: string ,
projectName: string ,
stringIndexType: string ,
assetKind: string ,
trainedModelLabel: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_Import (updated)
Description Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_Import",
  "Description": {
    "new": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.",
    "old": "Triggers a job to import a project. If a project with the same name already\nexists, the data of that project is replaced."
  },
  "$parameters": [
    {
      "#name": "format",
      "Description": {
        "new": "The format of the project to import. The currently supported formats are json and aml formats. If not provided, the default is set to json.",
        "old": "The format of the project to import. The currently supported formats are json\nand aml formats. If not provided, the default is set to json."
      }
    },
    {
      "body": {
        "$properties": [
          {
            "#name": "stringIndexType",
            "Description": {
              "new": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.",
              "old": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets."
            },
            "Enum": {
              "new": [
                [
                  "Utf16CodeUnit",
                  "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
                ]
              ],
              "old": [
                [
                  "Utf16CodeUnit",
                  "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript."
                ]
              ]
            }
          },
          {
            "metadata": [
              {
                "#name": "projectKind",
                "Enum": {
                  "new": [
                    [
                      "CustomSingleLabelClassification",
                      "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
                    ],
                    [
                      "CustomMultiLabelClassification",
                      "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
                    ],
                    [
                      "CustomEntityRecognition",
                      "For building an extraction model to identify your domain categories using your own data."
                    ],
                    [
                      "CustomAbstractiveSummarization",
                      "For building an abstractive summarization models which are able to summarize long documents."
                    ],
                    [
                      "CustomHealthcare",
                      "For building an text analytics for health model to identify your health domain data."
                    ],
                    [
                      "CustomTextSentiment",
                      "For building a sentiment models which are able to extract sentiment for long documents."
                    ]
                  ],
                  "old": [
                    [
                      "CustomSingleLabelClassification",
                      "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
                    ],
                    [
                      "CustomMultiLabelClassification",
                      "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
                    ],
                    [
                      "CustomEntityRecognition",
                      "For building an extraction model to identify your domain categories using your\nown data."
                    ],
                    [
                      "CustomAbstractiveSummarization",
                      "For building an abstractive summarization models which are able to summarize\nlong documents."
                    ],
                    [
                      "CustomHealthcare",
                      "For building an text analytics for health model to identify your health domain\ndata."
                    ],
                    [
                      "CustomTextSentiment",
                      "For building a sentiment models which are able to extract sentiment for long\ndocuments."
                    ]
                  ]
                }
              },
              {
                "settings": [
                  {
                    "#name": "confidenceThreshold",
                    "Description": {
                      "new": "The threshold of the class with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.",
                      "old": "The threshold of the class with the highest confidence, at which the prediction\nwill automatically be changed to \"None\". The value of the threshold should be\nbetween 0 and 1 inclusive."
                    }
                  }
                ]
              },
              {
                "#name": "language",
                "Description": {
                  "new": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
                  "old": "The project language. This is BCP-47 representation of a language. For example,\nuse \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
                }
              }
            ]
          },
          {
            "assets": [
              {
                "#name": "projectKind",
                "Enum": {
                  "new": [
                    [
                      "CustomSingleLabelClassification",
                      "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
                    ],
                    [
                      "CustomMultiLabelClassification",
                      "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
                    ],
                    [
                      "CustomEntityRecognition",
                      "For building an extraction model to identify your domain categories using your own data."
                    ],
                    [
                      "CustomAbstractiveSummarization",
                      "For building an abstractive summarization models which are able to summarize long documents."
                    ],
                    [
                      "CustomHealthcare",
                      "For building an text analytics for health model to identify your health domain data."
                    ],
                    [
                      "CustomTextSentiment",
                      "For building a sentiment models which are able to extract sentiment for long documents."
                    ]
                  ],
                  "old": [
                    [
                      "CustomSingleLabelClassification",
                      "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
                    ],
                    [
                      "CustomMultiLabelClassification",
                      "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
                    ],
                    [
                      "CustomEntityRecognition",
                      "For building an extraction model to identify your domain categories using your\nown data."
                    ],
                    [
                      "CustomAbstractiveSummarization",
                      "For building an abstractive summarization models which are able to summarize\nlong documents."
                    ],
                    [
                      "CustomHealthcare",
                      "For building an text analytics for health model to identify your health domain\ndata."
                    ],
                    [
                      "CustomTextSentiment",
                      "For building a sentiment models which are able to extract sentiment for long\ndocuments."
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:import
{
api-version: string ,
projectName: string ,
format: string ,
body:
{
projectFileVersion: string ,
stringIndexType: enum ,
metadata:
{
projectKind: enum ,
storageInputContainerName: string ,
settings:
{
confidenceThreshold: number ,
amlProjectPath: string ,
isLabelingLocked: boolean ,
runGptPredictions: boolean ,
gptPredictiveLookahead: integer ,
}
,
projectName: string ,
multilingual: boolean ,
description: string ,
language: string ,
}
,
assets:
{
projectKind: enum ,
}
,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_Train (updated)
Description Triggers a training job for a project.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_Train",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "evaluationOptions",
          "Description": {
            "new": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.",
            "old": "Represents the evaluation options. By default, the evaluation kind is\npercentage, with training split percentage as 80, and testing split percentage\nas 20."
          },
          "$properties": [
            {
              "#name": "kind",
              "Description": {
                "new": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.",
                "old": "Represents the evaluation kind. By default, the evaluation kind is set to\npercentage."
              },
              "Enum": {
                "new": [
                  [
                    "percentage",
                    "Split the data into training and test sets according to user-defined percentages."
                  ],
                  [
                    "manual",
                    "Split the data according to the chosen dataset for every example in the data."
                  ]
                ],
                "old": [
                  [
                    "percentage",
                    "Split the data into training and test sets according to user-defined\npercentages."
                  ],
                  [
                    "manual",
                    "Split the data according to the chosen dataset for every example in the data."
                  ]
                ]
              }
            },
            {
              "#name": "trainingSplitPercentage",
              "Description": {
                "new": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.",
                "old": "Represents the training dataset split percentage. Only needed in case the\nevaluation kind is percentage."
              }
            },
            {
              "#name": "testingSplitPercentage",
              "Description": {
                "new": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.",
                "old": "Represents the testing dataset split percentage. Only needed in case the\nevaluation kind is percentage."
              }
            }
          ]
        }
      ]
    }
  },
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/:train
{
api-version: string ,
projectName: string ,
body:
{
modelLabel: string ,
trainingConfigVersion: string ,
evaluationOptions:
{
kind: enum ,
trainingSplitPercentage: integer ,
testingSplitPercentage: integer ,
}
,
dataGenerationSettings:
{
enableDataGeneration: boolean ,
dataGenerationConnectionInfo:
{
kind: enum ,
resourceId: string ,
deploymentName: string ,
}
,
}
,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetCopyProjectStatus (updated)
Description Gets the status of an existing copy project job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetCopyProjectStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/copy/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_ListDeployments (updated)
Description Lists the deployments belonging to a project.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_ListDeployments",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
deploymentName: string ,
modelId: string ,
lastTrainedDateTime: string ,
lastDeployedDateTime: string ,
deploymentExpirationDate: string ,
modelTrainingConfigVersion: string ,
assignedResources:
[
{
resourceId: string ,
region: string ,
}
,
]
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetDeployment (updated)
Description Gets the details of a deployment.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetDeployment",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version: string ,
projectName: string ,
deploymentName: string ,
}

⚐ Response (200)

{
deploymentName: string ,
modelId: string ,
lastTrainedDateTime: string ,
lastDeployedDateTime: string ,
deploymentExpirationDate: string ,
modelTrainingConfigVersion: string ,
assignedResources:
[
{
resourceId: string ,
region: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_DeployProject (updated)
Description Creates a new deployment or replaces an existing one.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_DeployProject",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "assignedResourceIds",
          "Description": {
            "new": "Represents the resource IDs to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.",
            "old": "Represents the resource IDs to be assigned to the deployment.\nIf provided, the deployment will be rolled out to the resources\nprovided here as well as the original resource in which the project is created."
          }
        }
      ]
    }
  },
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version: string ,
projectName: string ,
deploymentName: string ,
body:
{
trainedModelLabel: string ,
assignedResourceIds:
[
string ,
]
,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_DeleteDeployment (updated)
Description Deletes a project deployment.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_DeleteDeployment",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version: string ,
projectName: string ,
deploymentName: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_DeleteDeploymentFromResources (updated)
Description Deletes a project deployment from the specified assigned resources.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_DeleteDeploymentFromResources",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "assignedResourceIds",
          "Description": {
            "new": "Represents the resource IDs to delete the deployment from. If not provided, the deployment will be rolled out from all the resources it is deployed to. If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.",
            "old": "Represents the resource IDs to delete the deployment from.\nIf not provided, the deployment will be rolled out from all the\nresources it is deployed to.\nIf provided, it will delete the deployment only from the specified\nassigned resources, and leave it for the rest."
          }
        }
      ]
    }
  },
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources
{
api-version: string ,
projectName: string ,
deploymentName: string ,
body:
{
assignedResourceIds:
[
string ,
]
,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus (updated)
Description Gets the status of an existing delete deployment from specific resources job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}
{
api-version: string ,
projectName: string ,
deploymentName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetDeploymentStatus (updated)
Description Gets the status of an existing deployment job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetDeploymentStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}
{
api-version: string ,
projectName: string ,
deploymentName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_SwapDeployments (updated)
Description Swaps two existing deployments with each other.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_SwapDeployments",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/deployments/:swap
{
api-version: string ,
projectName: string ,
body:
{
firstDeploymentName: string ,
secondDeploymentName: string ,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetSwapDeploymentsStatus (updated)
Description Gets the status of an existing swap deployment job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetSwapDeploymentsStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetExportStatus (updated)
Description Gets the status of an export job. Once job completes, returns the project metadata, and assets.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetExportStatus",
  "Description": {
    "new": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.",
    "old": "Gets the status of an export job. Once job completes, returns the project\nmetadata, and assets."
  },
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
resultUrl: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_ListExportedModels (updated)
Description Lists the exported models belonging to a project.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_ListExportedModels",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/exported-models
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
exportedModelName: string ,
modelId: string ,
lastTrainedDateTime: string ,
lastExportedModelDateTime: string ,
modelExpirationDate: string ,
modelTrainingConfigVersion: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetExportedModel (updated)
Description Gets the details of an exported model.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetExportedModel",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}
{
api-version: string ,
projectName: string ,
exportedModelName: string ,
}

⚐ Response (200)

{
exportedModelName: string ,
modelId: string ,
lastTrainedDateTime: string ,
lastExportedModelDateTime: string ,
modelExpirationDate: string ,
modelTrainingConfigVersion: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_CreateOrUpdateExportedModel (updated)
Description Creates a new exported model or replaces an existing one.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_CreateOrUpdateExportedModel",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}
{
api-version: string ,
projectName: string ,
exportedModelName: string ,
body:
{
trainedModelLabel: string ,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_DeleteExportedModel (updated)
Description Deletes an existing exported model.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_DeleteExportedModel",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}
{
api-version: string ,
projectName: string ,
exportedModelName: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetExportedModelJobStatus (updated)
Description Gets the status for an existing job to create or update an exported model.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetExportedModelJobStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/jobs/{jobId}
{
api-version: string ,
projectName: string ,
exportedModelName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetExportedModelManifest (updated)
Description Gets the details and URL needed to download the exported model.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetExportedModelManifest",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/manifest
{
api-version: string ,
projectName: string ,
exportedModelName: string ,
}

⚐ Response (200)

{
modelFiles:
[
{
name: string ,
contentUri: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetImportStatus (updated)
Description Gets the status for an import.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetImportStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_ListTrainedModels (updated)
Description Lists the trained models belonging to a project.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_ListTrainedModels",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
label: string ,
modelId: string ,
lastTrainedDateTime: string ,
lastTrainingDurationInSeconds: integer ,
modelExpirationDate: string ,
modelTrainingConfigVersion: string ,
hasSnapshot: boolean ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetTrainedModel (updated)
Description Gets the details of a trained model.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetTrainedModel",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
{
api-version: string ,
projectName: string ,
trainedModelLabel: string ,
}

⚐ Response (200)

{
label: string ,
modelId: string ,
lastTrainedDateTime: string ,
lastTrainingDurationInSeconds: integer ,
modelExpirationDate: string ,
modelTrainingConfigVersion: string ,
hasSnapshot: boolean ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_DeleteTrainedModel (updated)
Description Deletes an existing trained model.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_DeleteTrainedModel",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
{
api-version: string ,
projectName: string ,
trainedModelLabel: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_EvaluateModel (updated)
Description Triggers evaluation operation on a trained model.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_EvaluateModel",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "kind",
          "Description": {
            "new": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.",
            "old": "Represents the evaluation kind. By default, the evaluation kind is set to\npercentage."
          },
          "Enum": {
            "new": [
              [
                "percentage",
                "Split the data into training and test sets according to user-defined percentages."
              ],
              [
                "manual",
                "Split the data according to the chosen dataset for every example in the data."
              ]
            ],
            "old": [
              [
                "percentage",
                "Split the data into training and test sets according to user-defined\npercentages."
              ],
              [
                "manual",
                "Split the data according to the chosen dataset for every example in the data."
              ]
            ]
          }
        },
        {
          "#name": "trainingSplitPercentage",
          "Description": {
            "new": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.",
            "old": "Represents the training dataset split percentage. Only needed in case the\nevaluation kind is percentage."
          }
        },
        {
          "#name": "testingSplitPercentage",
          "Description": {
            "new": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.",
            "old": "Represents the testing dataset split percentage. Only needed in case the\nevaluation kind is percentage."
          }
        }
      ]
    }
  },
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:evaluate
{
api-version: string ,
projectName: string ,
trainedModelLabel: string ,
body:
{
kind: enum ,
trainingSplitPercentage: integer ,
testingSplitPercentage: integer ,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_LoadSnapshot (updated)
Description Long-running operation.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_LoadSnapshot",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot
{
api-version: string ,
projectName: string ,
trainedModelLabel: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetEvaluationStatus (updated)
Description Gets the status for an evaluation job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetEvaluationStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        },
        "result": [
          {
            "evaluationOptions": [
              {
                "#name": "kind",
                "Description": {
                  "new": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.",
                  "old": "Represents the evaluation kind. By default, the evaluation kind is set to\npercentage."
                },
                "Enum": {
                  "new": [
                    [
                      "percentage",
                      "Split the data into training and test sets according to user-defined percentages."
                    ],
                    [
                      "manual",
                      "Split the data according to the chosen dataset for every example in the data."
                    ]
                  ],
                  "old": [
                    [
                      "percentage",
                      "Split the data into training and test sets according to user-defined\npercentages."
                    ],
                    [
                      "manual",
                      "Split the data according to the chosen dataset for every example in the data."
                    ]
                  ]
                }
              },
              {
                "#name": "trainingSplitPercentage",
                "Description": {
                  "new": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.",
                  "old": "Represents the training dataset split percentage. Only needed in case the\nevaluation kind is percentage."
                }
              },
              {
                "#name": "testingSplitPercentage",
                "Description": {
                  "new": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.",
                  "old": "Represents the testing dataset split percentage. Only needed in case the\nevaluation kind is percentage."
                }
              }
            ]
          }
        ]
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}
{
api-version: string ,
projectName: string ,
trainedModelLabel: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
result:
{
evaluationOptions:
{
kind: enum ,
trainingSplitPercentage: integer ,
testingSplitPercentage: integer ,
}
,
modelLabel: string ,
trainingConfigVersion: string ,
percentComplete: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetModelEvaluationResults (updated)
Description Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetModelEvaluationResults",
  "Description": {
    "new": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.",
    "old": "Gets the detailed results of the evaluation for a trained model. This includes\nthe raw inference results for the data included in the evaluation process."
  },
  "$parameters": [
    {
      "#name": "stringIndexType",
      "Description": {
        "new": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.",
        "old": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "projectKind",
              "Enum": {
                "new": [
                  [
                    "CustomSingleLabelClassification",
                    "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
                  ],
                  [
                    "CustomMultiLabelClassification",
                    "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
                  ],
                  [
                    "CustomEntityRecognition",
                    "For building an extraction model to identify your domain categories using your own data."
                  ],
                  [
                    "CustomAbstractiveSummarization",
                    "For building an abstractive summarization models which are able to summarize long documents."
                  ],
                  [
                    "CustomHealthcare",
                    "For building an text analytics for health model to identify your health domain data."
                  ],
                  [
                    "CustomTextSentiment",
                    "For building a sentiment models which are able to extract sentiment for long documents."
                  ]
                ],
                "old": [
                  [
                    "CustomSingleLabelClassification",
                    "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
                  ],
                  [
                    "CustomMultiLabelClassification",
                    "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
                  ],
                  [
                    "CustomEntityRecognition",
                    "For building an extraction model to identify your domain categories using your\nown data."
                  ],
                  [
                    "CustomAbstractiveSummarization",
                    "For building an abstractive summarization models which are able to summarize\nlong documents."
                  ],
                  [
                    "CustomHealthcare",
                    "For building an text analytics for health model to identify your health domain\ndata."
                  ],
                  [
                    "CustomTextSentiment",
                    "For building a sentiment models which are able to extract sentiment for long\ndocuments."
                  ]
                ]
              }
            },
            {
              "#name": "language",
              "Description": {
                "new": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
                "old": "Represents the document language. This is BCP-47 representation of a language.\nFor example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish\netc."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result
{
api-version: string ,
projectName: string ,
trainedModelLabel: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
stringIndexType: string ,
}

⚐ Response (200)

{
value:
[
{
projectKind: enum ,
location: string ,
language: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetModelEvaluationSummary (updated)
Description Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetModelEvaluationSummary",
  "Description": {
    "new": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.",
    "old": "Gets the evaluation summary of a trained model. The summary includes high level\nperformance measurements of the model e.g., F1, Precision, Recall, etc."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "projectKind",
          "Enum": {
            "new": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your own data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize long documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain data."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long documents."
              ]
            ],
            "old": [
              [
                "CustomSingleLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile will have only one label. For example, file 1 is classified as A and file\n2 is classified as B."
              ],
              [
                "CustomMultiLabelClassification",
                "For building a classification model to classify text using your own data. Each\nfile can have one or many labels. For example, file 1 is classified as A, B,\nand C and file 2 is classified as B and C."
              ],
              [
                "CustomEntityRecognition",
                "For building an extraction model to identify your domain categories using your\nown data."
              ],
              [
                "CustomAbstractiveSummarization",
                "For building an abstractive summarization models which are able to summarize\nlong documents."
              ],
              [
                "CustomHealthcare",
                "For building an text analytics for health model to identify your health domain\ndata."
              ],
              [
                "CustomTextSentiment",
                "For building a sentiment models which are able to extract sentiment for long\ndocuments."
              ]
            ]
          }
        },
        {
          "evaluationOptions": [
            {
              "#name": "kind",
              "Description": {
                "new": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.",
                "old": "Represents the evaluation kind. By default, the evaluation kind is set to\npercentage."
              },
              "Enum": {
                "new": [
                  [
                    "percentage",
                    "Split the data into training and test sets according to user-defined percentages."
                  ],
                  [
                    "manual",
                    "Split the data according to the chosen dataset for every example in the data."
                  ]
                ],
                "old": [
                  [
                    "percentage",
                    "Split the data into training and test sets according to user-defined\npercentages."
                  ],
                  [
                    "manual",
                    "Split the data according to the chosen dataset for every example in the data."
                  ]
                ]
              }
            },
            {
              "#name": "trainingSplitPercentage",
              "Description": {
                "new": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.",
                "old": "Represents the training dataset split percentage. Only needed in case the\nevaluation kind is percentage."
              }
            },
            {
              "#name": "testingSplitPercentage",
              "Description": {
                "new": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.",
                "old": "Represents the testing dataset split percentage. Only needed in case the\nevaluation kind is percentage."
              }
            }
          ]
        }
      ]
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result
{
api-version: string ,
projectName: string ,
trainedModelLabel: string ,
}

⚐ Response (200)

{
projectKind: enum ,
evaluationOptions:
{
kind: enum ,
trainingSplitPercentage: integer ,
testingSplitPercentage: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetLoadSnapshotStatus (updated)
Description Gets the status for loading a snapshot.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetLoadSnapshotStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}
{
api-version: string ,
projectName: string ,
trainedModelLabel: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_ListDeploymentResources (updated)
Description Lists the deployments resources assigned to the project.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_ListDeploymentResources",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/resources
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
azureResourceId: string ,
region: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_AssignDeploymentResources (updated)
Description Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_AssignDeploymentResources",
  "Description": {
    "new": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory",
    "old": "Assign new Azure resources to a project to allow deploying new deployments to\nthem. This API is available only via AAD authentication and not supported via\nsubscription key authentication. For more details about AAD authentication,\ncheck here:\nhttps://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory"
  },
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/resources/:assign
{
api-version: string ,
projectName: string ,
body:
{
resourcesMetadata:
[
{
azureResourceId: string ,
customDomain: string ,
region: string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_UnassignDeploymentResources (updated)
Description Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_UnassignDeploymentResources",
  "Description": {
    "new": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.",
    "old": "Unassign resources from a project. This disallows deploying new deployments to\nthese resources, and deletes existing deployments assigned to them."
  },
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/resources/:unassign
{
api-version: string ,
projectName: string ,
body:
{
assignedResourceIds:
[
string ,
]
,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetAssignDeploymentResourcesStatus (updated)
Description Gets the status of an existing assign deployment resources job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetAssignDeploymentResourcesStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/resources/assign/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetUnassignDeploymentResourcesStatus (updated)
Description Gets the status of an existing unassign deployment resources job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetUnassignDeploymentResourcesStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/resources/unassign/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_ListTrainingJobs (updated)
Description Lists the non-expired training jobs created for a project.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_ListTrainingJobs",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "errors": {
              "$properties": [
                {
                  "#name": "innererror",
                  "Description": {
                    "new": "An object containing more specific information than the current object about the error.",
                    "old": "An object containing more specific information than the current object about\nthe error."
                  }
                }
              ]
            }
          }
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/train/jobs
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
result:
{
modelLabel: string ,
trainingConfigVersion: string ,
trainingStatus:
{
percentComplete: integer ,
startDateTime: string ,
endDateTime: string ,
status: enum ,
}
,
evaluationStatus:
{
percentComplete: integer ,
startDateTime: string ,
endDateTime: string ,
status: enum ,
}
,
estimatedEndDateTime: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetTrainingStatus (updated)
Description Gets the status for a training job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetTrainingStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
result:
{
modelLabel: string ,
trainingConfigVersion: string ,
trainingStatus:
{
percentComplete: integer ,
startDateTime: string ,
endDateTime: string ,
status: enum ,
}
,
evaluationStatus:
{
percentComplete: integer ,
startDateTime: string ,
endDateTime: string ,
status: enum ,
}
,
estimatedEndDateTime: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_CancelTrainingJob (updated)
Description Triggers a cancellation for a running training job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_CancelTrainingJob",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetProjectDeletionStatus (updated)
Description Gets the status for a project deletion job.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetProjectDeletionStatus",
  "$responses": {
    "200": {
      "$properties": {
        "errors": {
          "$properties": [
            {
              "#name": "innererror",
              "Description": {
                "new": "An object containing more specific information than the current object about the error.",
                "old": "An object containing more specific information than the current object about\nthe error."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/global/deletion-jobs/{jobId}
{
api-version: string ,
jobId: string ,
}

⚐ Response (200)

{
jobId: string ,
createdDateTime: string ,
lastUpdatedDateTime: string ,
expirationDateTime: string ,
status: enum ,
warnings:
[
{
code: string ,
message: string ,
}
,
]
,
errors:
[
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_ListAssignedResourceDeployments (updated)
Description Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_ListAssignedResourceDeployments",
  "Description": {
    "new": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.",
    "old": "Lists the deployments to which an Azure resource is assigned. This doesn't\nreturn deployments belonging to projects owned by this resource. It only\nreturns deployments belonging to projects owned by other resources."
  },
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/global/deployments/resources
{
api-version: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
projectName: string ,
deploymentsMetadata:
[
{
deploymentName: string ,
lastDeployedDateTime: string ,
deploymentExpirationDate: string ,
}
,
]
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetSupportedLanguages (updated)
Description Lists the supported languages.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetSupportedLanguages",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "languageCode",
              "Description": {
                "new": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
                "old": "The language code. This is BCP-47 representation of a language. For example,\n\"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
              }
            }
          ]
        }
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/global/languages
{
api-version: string ,
projectKind: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
languageName: string ,
languageCode: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_GetSupportedPrebuiltEntities (updated)
Description Lists the supported prebuilt entities that can be used while creating composed entities.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_GetSupportedPrebuiltEntities",
  "Description": {
    "new": "Lists the supported prebuilt entities that can be used while creating composed entities.",
    "old": "Lists the supported prebuilt entities that can be used while creating composed\nentities."
  },
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/global/prebuilt-entities
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
category: string ,
description: string ,
examples: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
TextAnalysisAuthoring_ListTrainingConfigVersions (updated)
Description Lists the support training config version for a given project type.
Reference Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoring_ListTrainingConfigVersions",
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "#name": "innererror",
            "Description": {
              "new": "An object containing more specific information than the current object about the error.",
              "old": "An object containing more specific information than the current object about\nthe error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/global/training-config-versions
{
api-version: string ,
projectKind: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
trainingConfigVersion: string ,
modelExpirationDate: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}